home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / programm.ing / ams__l~1.zoo / man / mousepos.man < prev    next >
Encoding:
Text File  |  1993-09-05  |  2.2 KB  |  77 lines
  1.                         ATARI MACHINE SPECIFIC LIBRARY
  2.  
  3.  
  4.  
  5. NAME
  6.      MousePosition - access to the Atari mouse
  7.  
  8. SYNOPSIS
  9.      #include <MousePosition.h>
  10.  
  11.      class MousePosition
  12.  
  13.      MousePosition Mouse
  14.  
  15. DESCRIPTION
  16.      For some styles of programming, access to the mouse via the AES and
  17.      VDI is inadequate.  This module provides a lower level of control.
  18.  
  19. VARIABLES
  20.      Mouse is a globally defined MousePosition.
  21.  
  22. CLASSES
  23.      class MousePosition provides the interface to a mouse.  Since the
  24.      Atari only supports one mouse, only one can be declared.
  25.  
  26. CLASS MEMBERS
  27.   MousePosition::
  28.  
  29.      int X()   - Returns current rigthward position of the mouse.
  30.      int Y()   - Returns current downward position of the mouse.
  31.  
  32.      bool LeftButton()    - TRUE if left button pressed.
  33.      bool RightButton()   - TRUE if right button pressed.
  34.  
  35.      int MoveTo(int,int)  - Set the mouse (x,y) position.
  36.      int MoveBy(int,int)  - Relative change in mouse (x,y) position.
  37.  
  38.      void Speed(short x,short y)   - Mouse speed 0=normal 255=slowest.
  39.  
  40.      void Unbound()           - Unbounded mouse - default.
  41.      void Bound(Rectangle)    - Bound mouse to area.
  42.      void Bound(int MinX=0, int MinY=0, int Width=MAXINT, int Height=MAXINT)
  43.                               - Bound mouse to area.
  44.  
  45.      void SetLeft(bool)   - Set left button status (rarely useful)
  46.      void SetRight(bool)  - Set right button status (rarely useful)
  47.  
  48. USAGE
  49.      Simply access the Mouse.*() functions.
  50.  
  51.      When the mouse is bound, it operates similarly to the way the
  52.      mouse does in the GEM environment.
  53.  
  54.      When the mouse is unbound, you will probably use the MoveTo and
  55.      MoveBy members.
  56.  
  57. SEE ALSO
  58.      Joystick
  59.  
  60. BUGS
  61.      Only one MousePosition may be declared (ie. the Mouse already defined)
  62.  
  63. AUTHOR
  64.      Warwick Allison, 1992.
  65.      warwick@cs.uq.oz.au
  66.  
  67. COPYING
  68.      This functionality is part of the Atari Machine Specific Library,
  69.      and is Copyright 1992 by Warwick W. Allison.
  70.  
  71.      The Atari Machine Specific Library is free and protected under the
  72.      GNU Library General Public License.
  73.  
  74.      You are free to copy and modify these sources, provided you acknowledge
  75.      the origin by retaining this notice, and adhere to the conditions
  76.      described in the GNU LGPL.
  77.